home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / editors / emacs / xemacs / xemacs-1.006 / xemacs-1 / lib / xemacs-19.13 / lisp / packages / buff-menu.el < prev    next >
Encoding:
Text File  |  1995-04-17  |  16.6 KB  |  480 lines
  1. ;;; buff-menu.el --- buffer menu main function and support functions.
  2.  
  3. ;; Copyright (C) 1985-1993 Free Software Foundation, Inc.
  4.  
  5. ;; This file is part of XEmacs.
  6.  
  7. ;; XEmacs is free software; you can redistribute it and/or modify it
  8. ;; under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation; either version 2, or (at your option)
  10. ;; any later version.
  11.  
  12. ;; XEmacs is distributed in the hope that it will be useful, but
  13. ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  14. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15. ;; General Public License for more details.
  16.  
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with XEmacs; see the file COPYING.  If not, write to the Free
  19. ;; Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  20.  
  21. ;;; Synched up with: Not synched with FSF.
  22.  
  23. ; Put buffer *Buffer List* into proper mode right away
  24. ; so that from now on even list-buffers is enough to get a buffer menu.
  25.  
  26. (provide 'buff-menu)
  27.  
  28. (defvar Buffer-menu-mode-map nil "")
  29.  
  30. (if Buffer-menu-mode-map
  31.     ()
  32.   (setq Buffer-menu-mode-map (make-keymap))
  33.   (suppress-keymap Buffer-menu-mode-map t)
  34.   (set-keymap-name Buffer-menu-mode-map 'Buffer-menu-mode-map)
  35.   (define-key Buffer-menu-mode-map "q" 'Buffer-menu-select)
  36.   (define-key Buffer-menu-mode-map "2" 'Buffer-menu-2-window)
  37.   (define-key Buffer-menu-mode-map "1" 'Buffer-menu-1-window)
  38.   (define-key Buffer-menu-mode-map "f" 'Buffer-menu-this-window)
  39.   (define-key Buffer-menu-mode-map "o" 'Buffer-menu-other-window)
  40.   (define-key Buffer-menu-mode-map "s" 'Buffer-menu-save)
  41.   (define-key Buffer-menu-mode-map "d" 'Buffer-menu-delete)
  42.   (define-key Buffer-menu-mode-map "k" 'Buffer-menu-delete)
  43.   (define-key Buffer-menu-mode-map "\C-d" 'Buffer-menu-delete-backwards)
  44.   (define-key Buffer-menu-mode-map "\C-k" 'Buffer-menu-delete)
  45.   (define-key Buffer-menu-mode-map "x" 'Buffer-menu-execute)
  46.   (define-key Buffer-menu-mode-map " " 'next-line)
  47.   (define-key Buffer-menu-mode-map "\177" 'Buffer-menu-backup-unmark)
  48.   (define-key Buffer-menu-mode-map "~" 'Buffer-menu-not-modified)
  49.   (define-key Buffer-menu-mode-map "?" 'describe-mode)
  50.   (define-key Buffer-menu-mode-map "u" 'Buffer-menu-unmark)
  51.   (define-key Buffer-menu-mode-map "m" 'Buffer-menu-mark)
  52.   (define-key Buffer-menu-mode-map "t" 'Buffer-menu-visit-tags-table)
  53.   (define-key Buffer-menu-mode-map 'button2 'Buffer-menu-mouse-select)
  54.   (define-key Buffer-menu-mode-map 'button3 'Buffer-menu-popup-menu)
  55.   )
  56.  
  57. ;; Buffer Menu mode is suitable only for specially formatted data.
  58. (put 'Buffer-menu-mode 'mode-class 'special)
  59.  
  60. (defun Buffer-menu-mode ()
  61.   "Major mode for editing a list of buffers.
  62. Each line describes one of the buffers in Emacs.
  63. Letters do not insert themselves; instead, they are commands.
  64. m -- mark buffer to be displayed.
  65. q -- select buffer of line point is on.
  66.   Also show buffers marked with m in other windows.
  67. 1 -- select that buffer in full-frame window.
  68. 2 -- select that buffer in one window,
  69.   together with buffer selected before this one in another window.
  70. f -- select that buffer in place of the buffer menu buffer.
  71. o -- select that buffer in another window,
  72.   so the buffer menu buffer remains visible in its window.
  73. t -- visit-tags-table this buffer.
  74. ~ -- clear modified-flag on that buffer.
  75. s -- mark that buffer to be saved, and move down.
  76. d or k -- mark that buffer to be deleted, and move down.
  77. C-d -- mark that buffer to be deleted, and move up.
  78. x -- delete or save marked buffers.
  79. u -- remove all kinds of marks from current line.
  80. Delete -- back up a line and remove marks.
  81.  
  82. Precisely,\\{Buffer-menu-mode-map}"
  83.   (kill-all-local-variables)
  84.   (use-local-map Buffer-menu-mode-map)
  85.   (setq truncate-lines t)
  86.   (setq buffer-read-only t)
  87.   (setq major-mode 'Buffer-menu-mode)
  88.   (setq mode-name "Buffer Menu")
  89.   (require 'mode-motion)
  90.   (setq mode-motion-hook 'mode-motion-highlight-line)
  91.   (make-local-variable 'mouse-track-click-hook)
  92.   (add-hook 'mouse-track-click-hook 'Buffer-menu-maybe-mouse-select)
  93.   (run-hooks 'buffer-menu-mode-hook))
  94.  
  95. (defvar Buffer-menu-buffer-column 4)
  96.  
  97. ;; from mly@ai.mit.edu (Richard Mlynarik)
  98. (defun Buffer-menu-buffer (error-if-non-existent-p)
  99.   "Return buffer described by this line of buffer menu."
  100.   (save-excursion
  101.     (beginning-of-line)
  102.     (forward-char Buffer-menu-buffer-column)
  103.     (let* ((start (point))
  104.            (string (if (/= (preceding-char) ?\")
  105.                        ;; End of buffer name marked by tab or a space.
  106.                        (progn (re-search-forward "\t\\| ")
  107.                               (skip-chars-backward " \t")
  108.                               (buffer-substring start (point)))
  109.                        (progn
  110.                          (backward-char 1)
  111.                          (read (current-buffer))))))
  112.       (or (get-buffer string)
  113.       (if error-if-non-existent-p
  114.           (error "No buffer named \"%s\"" string)
  115.         nil)))))
  116.  
  117. (defvar list-buffers-header-line
  118.   (purecopy (concat " MR Buffer           Size  Mode         File\n"
  119.                     " -- ------           ----  ----         ----\n")))
  120.  
  121. (defvar list-buffers-identification 'default-list-buffers-identification
  122.   "String used to identify this buffer, or a function of one argument
  123. to generate such a string.  This variable is always buffer-local.")
  124. (make-variable-buffer-local 'list-buffers-identification)
  125.  
  126. (defvar list-buffers-directory)
  127. (make-variable-buffer-local 'list-buffers-directory)
  128.  
  129. (defun default-list-buffers-identification (output)
  130.   (save-excursion
  131.     (let ((file (or (buffer-file-name (current-buffer))
  132.             (and (boundp 'list-buffers-directory)
  133.              list-buffers-directory)))
  134.       (size (buffer-size))
  135.       (mode mode-name)
  136.       eob p s col)
  137.       (set-buffer output)
  138.       (end-of-line)
  139.       (setq eob (point))
  140.       (prin1 size)
  141.       (setq p (point))
  142.       ;; right-justify the size
  143.       (move-to-column 19 t)
  144.       (setq col (point))
  145.       (if (> eob col)
  146.       (goto-char eob))
  147.       (setq s (- 6 (- p col)))
  148.       (while (> s 0) ; speed/consing tradeoff...
  149.     (insert ? )
  150.     (setq s (1- s)))
  151.       (end-of-line)
  152.       (indent-to 27 1)
  153.       (insert mode)
  154.       (if (not file)
  155.       nil
  156.     ;; if the mode-name is really long, clip it for the filename
  157.     (if (> 0 (setq s (- 39 (current-column))))
  158.         (delete-char (max s (- eob (point)))))
  159.     (indent-to 40 1)
  160.     (insert file)))))
  161.  
  162. (defun list-buffers-internal (output &optional predicate)
  163.   (let ((current (current-buffer))
  164.         (buffers (buffer-list)))
  165.     (save-excursion
  166.       (set-buffer output)
  167.       (Buffer-menu-mode)
  168.       (setq buffer-read-only nil)
  169.       (buffer-disable-undo output)
  170.       (insert list-buffers-header-line)
  171.  
  172.       (while buffers
  173.         (let* ((col1 19)
  174.                (buffer (car buffers))
  175.                (name (buffer-name buffer)))
  176.           (setq buffers (cdr buffers))
  177.           (cond ((null name))           ;deleted buffer
  178.                 ((and predicate
  179.                       (not (if (stringp predicate)
  180.                                (string-match predicate name)
  181.                                (funcall predicate buffer))))
  182.                  nil)
  183.                 (t
  184.                  (set-buffer buffer)
  185.                  (let ((ro buffer-read-only)
  186.                        (id list-buffers-identification))
  187.                    (set-buffer output)
  188.                    (insert (if (eq buffer current)
  189.                                (progn (setq current (point)) ?\.)
  190.                                ?\ ))
  191.                    (insert (if (buffer-modified-p buffer)
  192.                                ?\* 
  193.                                ?\ ))
  194.                    (insert (if ro
  195.                                ?\%
  196.                                ?\ ))
  197.                    (if (string-match "[\n\"\\ \t]" name)
  198.                        (let ((print-escape-newlines t))
  199.                          (prin1 name output))
  200.                        (insert ?\  name))
  201.                    (indent-to col1 1)
  202.                    (cond ((stringp id)
  203.                           (insert id))
  204.                          (id
  205.                           (set-buffer buffer)
  206.                           (condition-case e
  207.                               (funcall id output)
  208.                             (error
  209.                              (princ "***" output) (prin1 e output)))
  210.                           (set-buffer output)
  211.                           (goto-char (point-max)))))
  212.                  (insert ?\n)))))
  213.  
  214.       (setq buffer-read-only t)
  215.       (if (not (bufferp current))
  216.           (goto-char current)))))
  217.  
  218. (defun list-buffers (&optional files-only)
  219.   "Display a list of names of existing buffers.
  220. Inserts it in buffer *Buffer List* and displays that.
  221. Note that buffers with names starting with spaces are omitted.
  222. Non-null optional arg FILES-ONLY means mention only file buffers.
  223.  
  224. The M column contains a * for buffers that are modified.
  225. The R column contains a % for buffers that are read-only."
  226.   (interactive (list (if current-prefix-arg t nil)))
  227.   (with-output-to-temp-buffer "*Buffer List*"
  228.     (save-excursion
  229.       (list-buffers-internal standard-output
  230.                              (if (memq files-only '(t nil))
  231.                                  #'(lambda (b)
  232.                                      (let ((n (buffer-name b)))
  233.                                        (cond ((and (/= 0 (length n))
  234.                                                    (= (aref n 0) ?\ ))
  235.                                               ;;don't mention if starts with " "
  236.                                               nil)
  237.                                              (files-only
  238.                                               (buffer-file-name b))
  239.                                              (t
  240.                                               t))))
  241.                                  files-only)))))
  242.  
  243. (defun buffer-menu (arg)
  244.   "Make a menu of buffers so you can save, delete or select them.
  245. With argument, show only buffers that are visiting files.
  246. Type ? after invocation to get help on commands available.
  247. Type q immediately to make the buffer menu go away."
  248.   (interactive "P")
  249.   (list-buffers arg)
  250.   (pop-to-buffer "*Buffer List*")
  251.   (forward-line 2)
  252.   (message
  253.    "Commands: d, s, x; 1, 2, m, u, q; delete; ~;  ? for help."))
  254.  
  255. (defun Buffer-menu-mark ()
  256.   "Mark buffer on this line for being displayed by \\[Buffer-menu-select] command."
  257.   (interactive)
  258.   (beginning-of-line)
  259.   (if (looking-at " [-M]")
  260.       (ding)
  261.     (let ((buffer-read-only nil))
  262.       (delete-char 1)
  263.       (insert ?>)
  264.       (forward-line 1))))
  265.  
  266. (defun Buffer-menu-unmark ()
  267.   "Cancel all requested operations on buffer on this line."
  268.   (interactive)
  269.   (beginning-of-line)
  270.   (if (looking-at " [-M]")
  271.       (ding)
  272.     (let* ((buf (Buffer-menu-buffer t))
  273.        (mod (buffer-modified-p buf))
  274.        (readonly (save-excursion (set-buffer buf) buffer-read-only))
  275.        (buffer-read-only nil))
  276.       (delete-char 3)
  277.       (insert (if readonly (if mod " *%" "  %") (if mod " * " "   ")))))
  278.   (forward-line 1))
  279.  
  280. (defun Buffer-menu-backup-unmark ()
  281.   "Move up and cancel all requested operations on buffer on line above."
  282.   (interactive)
  283.   (forward-line -1)
  284.   (Buffer-menu-unmark)
  285.   (forward-line -1))
  286.  
  287. (defun Buffer-menu-delete ()
  288.   "Mark buffer on this line to be deleted by \\[Buffer-menu-execute] command."
  289.   (interactive)
  290.   (beginning-of-line)
  291.   (if (looking-at " [-M]")        ;header lines
  292.       (ding)
  293.     (let ((buffer-read-only nil))
  294.       (delete-char 1)
  295.       (insert ?D)
  296.       (forward-line 1))))
  297.  
  298. (defun Buffer-menu-delete-backwards ()
  299.   "Mark buffer on this line to be deleted by \\[Buffer-menu-execute] command
  300. and then move up one line"
  301.   (interactive)
  302.   (Buffer-menu-delete)
  303.   (forward-line -2)
  304.   (if (looking-at " [-M]") (forward-line 1)))
  305.  
  306. (defun Buffer-menu-save ()
  307.   "Mark buffer on this line to be saved by \\[Buffer-menu-execute] command."
  308.   (interactive)
  309.   (beginning-of-line)
  310.   (forward-char 1)
  311.   (if (looking-at " [-M]")        ;header lines
  312.       (ding)
  313.     (let ((buffer-read-only nil))
  314.       (delete-char 1)
  315.       (insert ?S)
  316.       (forward-line 1))))
  317.  
  318. (defun Buffer-menu-not-modified ()
  319.   "Mark buffer on this line as unmodified (no changes to save)."
  320.   (interactive)
  321.   (save-excursion
  322.     (set-buffer (Buffer-menu-buffer t))
  323.     (set-buffer-modified-p nil))
  324.   (save-excursion
  325.    (beginning-of-line)
  326.    (forward-char 1)
  327.    (if (looking-at "\\*")
  328.        (let ((buffer-read-only nil))
  329.      (delete-char 1)
  330.      (insert ? )))))
  331.  
  332. (defun Buffer-menu-execute ()
  333.   "Save and/or delete buffers marked with \\[Buffer-menu-save] or \\[Buffer-menu-delete] commands."
  334.   (interactive)
  335.   (save-excursion
  336.     (goto-char (point-min))
  337.     (forward-line 1)
  338.     (while (re-search-forward "^.S" nil t)
  339.       (let ((modp nil))
  340.     (save-excursion
  341.       (set-buffer (Buffer-menu-buffer t))
  342.       (save-buffer)
  343.       (setq modp (buffer-modified-p)))
  344.     (let ((buffer-read-only nil))
  345.       (delete-char -1)
  346.       (insert (if modp ?* ? ))))))
  347.   (save-excursion
  348.     (goto-char (point-min))
  349.     (forward-line 1)
  350.     (let ((buff-menu-buffer (current-buffer))
  351.       (buffer-read-only nil))
  352.       (while (search-forward "\nD" nil t)
  353.     (forward-char -1)
  354.     (let ((buf (Buffer-menu-buffer nil)))
  355.       (or (eq buf nil)
  356.           (eq buf buff-menu-buffer)
  357.           (save-excursion (kill-buffer buf))))
  358.     (if (Buffer-menu-buffer nil)
  359.         (progn (delete-char 1)
  360.            (insert ? ))
  361.       (delete-region (point) (progn (forward-line 1) (point)))
  362.        (forward-char -1))))))
  363.  
  364. (defun Buffer-menu-select ()
  365.   "Select this line's buffer; also display buffers marked with \">\".
  366. You can mark buffers with the \\[Buffer-menu-mark] command."
  367.   (interactive)
  368.   (let ((buff (Buffer-menu-buffer t))
  369.     (menu (current-buffer))          
  370.     (others ())
  371.     tem)
  372.     (goto-char (point-min))
  373.     (while (search-forward "\n>" nil t)
  374.       (setq tem (Buffer-menu-buffer t))
  375.       (let ((buffer-read-only nil))
  376.     (delete-char -1)
  377.     (insert ?\ ))
  378.       (or (eq tem buff) (memq tem others) (setq others (cons tem others))))
  379.     (setq others (nreverse others)
  380.       tem (/ (1- (frame-height)) (1+ (length others))))
  381.     (delete-other-windows)
  382.     (switch-to-buffer buff)
  383.     (or (eq menu buff)
  384.     (bury-buffer menu))
  385.     (while others
  386.       (split-window nil tem)
  387.       (other-window 1)
  388.       (switch-to-buffer (car others))
  389.       (setq others (cdr others)))
  390.     (other-window 1)))            ;back to the beginning!
  391.  
  392. (defun Buffer-menu-visit-tags-table ()
  393.   "Visit the tags table in the buffer on this line.  See `visit-tags-table'."
  394.   (interactive)
  395.   (let ((file (buffer-file-name (Buffer-menu-buffer t))))
  396.     (if file
  397.     (visit-tags-table file)
  398.       (error "Specified buffer has no file"))))
  399.  
  400. (defun Buffer-menu-1-window ()
  401.   "Select this line's buffer, alone, in full frame."
  402.   (interactive)
  403.   (switch-to-buffer (Buffer-menu-buffer t))
  404.   (bury-buffer (other-buffer))
  405.   (delete-other-windows)
  406.   ;; This is to get w->force_start set to nil.  Don't ask me, I only work here.
  407.   (set-window-buffer (selected-window) (current-buffer)))
  408.  
  409. (defun Buffer-menu-this-window ()
  410.   "Select this line's buffer in this window."
  411.   (interactive)
  412.   (switch-to-buffer (Buffer-menu-buffer t)))
  413.  
  414. (defun Buffer-menu-other-window ()
  415.   "Select this line's buffer in other window, leaving buffer menu visible."
  416.   (interactive)
  417.   (switch-to-buffer-other-window (Buffer-menu-buffer t)))
  418.  
  419. (defun Buffer-menu-2-window ()
  420.   "Select this line's buffer, with previous buffer in second window."
  421.   (interactive)
  422.   (let ((buff (Buffer-menu-buffer t))
  423.     (menu (current-buffer))
  424.     (pop-up-windows t))
  425.     (switch-to-buffer (other-buffer))
  426.     (pop-to-buffer buff)
  427.     (bury-buffer menu)))
  428.  
  429.  
  430. ;;; mouseability
  431.  
  432. (defun Buffer-menu-mouse-select (event)
  433.   (interactive "e")
  434.   (mouse-set-point event)
  435.   (Buffer-menu-select))
  436.  
  437. (defun Buffer-menu-maybe-mouse-select (event &optional click-count)
  438.   (interactive "e")
  439.   (and (>= click-count 2)
  440.        (let ((buffer (current-buffer))
  441.          (point (point))
  442.          (config (current-window-configuration)))
  443.      (condition-case nil
  444.          (progn
  445.            (Buffer-menu-mouse-select event)
  446.            t)
  447.        (error
  448.         (set-window-configuration config)
  449.         (set-buffer buffer)
  450.         (goto-char point)
  451.         nil)))))
  452.  
  453. (defvar Buffer-menu-popup-menu
  454.   '("Buffer Commands"
  455.     ["Select Buffer"            Buffer-menu-select        t]
  456.     ["Select buffer Other Window"    Buffer-menu-other-window    t]
  457.     ["Clear Buffer Modification Flag"    Buffer-menu-not-modified    t]
  458.     "----"
  459.     ["Mark Buffer for Selection"    Buffer-menu-mark        t]
  460.     ["Mark Buffer for Save"        Buffer-menu-save        t]
  461.     ["Mark Buffer for Deletion"        Buffer-menu-delete        t]
  462.     ["Unmark Buffer"            Buffer-menu-unmark        t]
  463.     "----"
  464.     ["Delete/Save Marked Buffers"    Buffer-menu-execute        t]
  465.     ))
  466.  
  467. (defun Buffer-menu-popup-menu (event)
  468.   (interactive "e")
  469.   (mouse-set-point event)
  470.   (beginning-of-line)
  471.   (let ((buffer (Buffer-menu-buffer nil)))
  472.     (if buffer
  473.     (popup-menu
  474.      (nconc (list (car Buffer-menu-popup-menu)
  475.               (concat
  476.                "Commands on buffer \"" (buffer-name buffer) "\":")
  477.               "----")
  478.         (cdr Buffer-menu-popup-menu)))
  479.       (error "no buffer on this line"))))
  480.